<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: include/trcTimestamp.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.10.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('trcTimestamp_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle"><div class="title">trcTimestamp.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Public trace timestamp APIs.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;trcTypes.h&gt;</code><br />
</div>
<p><a href="trcTimestamp_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTraceTimestampData.html">TraceTimestampData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trace Timestamp Structure.  <a href="structTraceTimestampData.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaf1df1208059acfa9ed418a70d50be4e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__timestamp__apis.html#gaf1df1208059acfa9ed418a70d50be4e5">xTraceTimestampGet</a>(puiTimestamp)&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_4(*(puiTimestamp) = TRC_HWTC_COUNT, (*(puiTimestamp) &lt; pxTraceTimestamp-&gt;latestTimestamp) ? pxTraceTimestamp-&gt;wraparounds++ : 0, pxTraceTimestamp-&gt;latestTimestamp = *(puiTimestamp), TRC_SUCCESS)</td></tr>
<tr class="memdesc:gaf1df1208059acfa9ed418a70d50be4e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets current trace timestamp.  <br /></td></tr>
<tr class="separator:gaf1df1208059acfa9ed418a70d50be4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacb2d292f0b068d6653eed16bdfa64540"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__timestamp__apis.html#gacb2d292f0b068d6653eed16bdfa64540">xTraceTimestampGetWraparounds</a>(puiTimerWraparounds)&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiTimerWraparounds) = pxTraceTimestamp-&gt;wraparounds, TRC_SUCCESS)</td></tr>
<tr class="memdesc:gacb2d292f0b068d6653eed16bdfa64540"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace timestamp wraparounds.  <br /></td></tr>
<tr class="separator:gacb2d292f0b068d6653eed16bdfa64540"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e582d9f384f366f5d44dd9033e160c8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__timestamp__apis.html#ga7e582d9f384f366f5d44dd9033e160c8">xTraceTimestampSetFrequency</a>(uxFrequency)&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp-&gt;frequency = uxFrequency, TRC_SUCCESS)</td></tr>
<tr class="memdesc:ga7e582d9f384f366f5d44dd9033e160c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace timestamp frequency.  <br /></td></tr>
<tr class="separator:ga7e582d9f384f366f5d44dd9033e160c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaebd43421b8dd4fbc59e57ef8faf1969"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__timestamp__apis.html#gaaebd43421b8dd4fbc59e57ef8faf1969">xTraceTimestampSetPeriod</a>(uiPeriod)&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp-&gt;period = uiPeriod, TRC_SUCCESS)</td></tr>
<tr class="memdesc:gaaebd43421b8dd4fbc59e57ef8faf1969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace timestamp period.  <br /></td></tr>
<tr class="separator:gaaebd43421b8dd4fbc59e57ef8faf1969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4c8f56e6cfdc4c041c25dfc8e9c53a12"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__timestamp__apis.html#ga4c8f56e6cfdc4c041c25dfc8e9c53a12">xTraceTimestampSetOsTickCount</a>(uiOsTickCount)&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp-&gt;osTickCount = uiOsTickCount, TRC_SUCCESS)</td></tr>
<tr class="memdesc:ga4c8f56e6cfdc4c041c25dfc8e9c53a12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace timestamp OS tick count.  <br /></td></tr>
<tr class="separator:ga4c8f56e6cfdc4c041c25dfc8e9c53a12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa2305ef12c3f6c996a56ba3f2fe7120c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__timestamp__apis.html#gaa2305ef12c3f6c996a56ba3f2fe7120c">xTraceTimestampGetFrequency</a>(puxFrequency)&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puxFrequency) = pxTraceTimestamp-&gt;frequency, TRC_SUCCESS)</td></tr>
<tr class="memdesc:gaa2305ef12c3f6c996a56ba3f2fe7120c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace timestamp frequency.  <br /></td></tr>
<tr class="separator:gaa2305ef12c3f6c996a56ba3f2fe7120c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa2ab98ff676a9aab177721d921fee84"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__timestamp__apis.html#gaaa2ab98ff676a9aab177721d921fee84">xTraceTimestampGetPeriod</a>(puiPeriod)&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiPeriod) = pxTraceTimestamp-&gt;period, TRC_SUCCESS)</td></tr>
<tr class="memdesc:gaaa2ab98ff676a9aab177721d921fee84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace timestamp period.  <br /></td></tr>
<tr class="separator:gaaa2ab98ff676a9aab177721d921fee84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5cd3d2acef0691b00a18ca7b9f0eb827"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__timestamp__apis.html#ga5cd3d2acef0691b00a18ca7b9f0eb827">xTraceTimestampGetOsTickCount</a>(puiOsTickCount)&#160;&#160;&#160;TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiOsTickCount) = pxTraceTimestamp-&gt;osTickCount, TRC_SUCCESS)</td></tr>
<tr class="memdesc:ga5cd3d2acef0691b00a18ca7b9f0eb827"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace timestamp OS tick count.  <br /></td></tr>
<tr class="separator:ga5cd3d2acef0691b00a18ca7b9f0eb827"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga8b7c675ec2e8975af31f37bc1b7da5d0"><td class="memItemLeft" align="right" valign="top">
typedef struct <a class="el" href="structTraceTimestampData.html">TraceTimestampData</a>&#160;</td><td class="memItemRight" valign="bottom"><b>TraceTimestampData_t</b></td></tr>
<tr class="memdesc:ga8b7c675ec2e8975af31f37bc1b7da5d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trace Timestamp Structure. <br /></td></tr>
<tr class="separator:ga8b7c675ec2e8975af31f37bc1b7da5d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Public trace timestamp APIs. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="trcTimestamp_8h.html">trcTimestamp.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
